Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Profiling documentation #536

Merged

Conversation

outtanames
Copy link
Contributor

Short doc describing nos profile. Also includes funcionality to override catalog path from env with NOS_PROFILE_CATALOG_PATH_OVERRIDE (for use with nos profile list).

Checks

  • make lint: I've run make lint to lint the changes in this PR.
  • make test: I've made sure the tests (make test-cpu or make test) are passing.
  • Additional tests:
    • Benchmark tests (when contributing new models)
    • GPU/HW tests

```bash
pip install torch-nos[server,test]
```

Copy link
Contributor

@spillai spillai Jan 31, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be helpful to break this README by subcommand:

First, can you print the output of nos profile --help here so that the users can see the relevant subcommands supported?

Then you can have different sections such as

nos profile rebuild-catalog

...

nos profile method -m <model-id>

nos profile method -t <model-type>


Or an entire method type with
```bash
nos profile method -m encode_image
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are method type and method names interchangeable here with -m flag? Wouldn't we want them to have a different flag? -m for model name and -t for method type?

logger = logging.getLogger(__name__)
debug_str = "Loading profiling catalog from " + str(NOS_PROFILE_CATALOG_PATH)
# Check if we have NOS_PROFILE_CATALOG_PATH_OVERRIDE in the environment
if "NOS_PROFILE_CATALOG_PATH_OVERRIDE" in os.environ:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use os.environ.get("...", None) instead?

@outtanames outtanames merged commit 901b83d into autonomi-ai:main Feb 1, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants